.. highlightlang:: us

.. index:: @f{legend}

.. _@f{legend}:

@f{legend}
==========

.. us.tag  @f{legend} GERMAN fieldfunction Changed5100

Erzeugt eine Legende für 1D- und 2D-Datensätze.

.. function::  @f{legend}
    @f{Legend(DiagramName1, DiagramName2, ...)}
    @f{legend(DiagramName, DatasetIndex)}

.. us.comment

**Kommentar**

Der Text für die Legende kann über den Konfigurations-Dialog
:ref:`daten1d-und-2d-datensatz` des entsprechenden Datensatzes geändert
werden. Die Legende wird aktualisiert, wenn sich der Text oder Datensatzstil
eines Datensatzes ändert und wenn Datensätze zugefügt oder entfernt werden.

Falls der Text mit einem Ausrufungszeichen "!" beginnt, wird der Datensatz
nicht in die Legende eingetragen. 

.. us.example

**Beispiel**

``@f{legend(Luft-T, Drehzahl, Kühlmittel-T, Ladedruck, dpdt)}``

**Ausgabe**:

.. image:: S:/uniplot-obj/images/Feldfunktion_Legend.*

Wenn Sie den Konfigurationsdialog des Textobjekts mit einem Doppelklick öffnen,
sehen Sie den folgenden Text:

.. image:: S:/uniplot-obj/images/Textdialog_Feldfunktion_Legende.*

Am Anfang steht die Feldfunktion
``@f{legend(Luft-T, Drehzahl, Kühlmittel-T, Ladedruck, dpdt)}``. Als Parameter
wurden die Namen der Diagramme übergeben, die von der Feldfunktion berücksichtigt
werden sollen. Die Feldfunkion erzeugt dann für jeden Datensatz der angegebenen
Diagramme eine Textzeile. Die Textzeilen werden als Feldergebnis in geschweiften
Klammern direkt hinter der Feldfunktion ausgegeben. Das Feldergebnis sollte nicht
bearbeitet werden, da die Änderungen beim Schließen des Dialogs wieder
überschrieben werden.

Die Textobjekte mit der Feldfunktion können Sie mit dem Befehl
:ref:`diagrammweitere-diagramm-funktionenlegende-fur-2d-datensatze-erzeugen` in
das Dokument einfügen. Soll die Feldfunktion nicht alle Diagramme
berücksichtigen, können Sie aus der Parameterliste der Feldfunktion die
entsprechenden Diagrammnamen entfernen.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - 5.10.0
     - Falls der Text mit einem Ausrufungszeichen "!" beginnt, wird der Datensatz nicht in die Legende eingetragen.

.. seealso::
   :ref:`uberblick-feldfunktionen`,
   :ref:`bearbeitenfelder-aktualisieren`,
   :ref:`diagrammfeldfunktion-einfugen`,
   :ref:`dateialias-tabelle-bearbeiten`

:sub:`id-1817341`